Esx Settings Inventory AssignEntitiesSpec

Esx Settings Inventory AssignEntitiesSpec
Esx Settings Inventory AssignEntitiesSpec

The Esx Settings Inventory AssignEntitiesSpec contains properties used to assign a software specification from the repository to a list of entities.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "software_spec_id": "string",
    "entities": {
        "type": "string",
        "hosts": [
            "string"
        ],
        "clusters": [
            "string"
        ],
        "folders": [
            "string"
        ],
        "datacenters": [
            "string"
        ]
    },
    "orchestrator": {
        "owner": "string",
        "owner_data": "string"
    }
}
string
software_spec_id
Required

The software spec in the repository that will be assigned to the list of entities.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec.

entities
Required

Specification of entities on which the specified operation should be invoked.

This property was added in vSphere API 9.0.0.0.

orchestrator
Optional

Orchestrator specification of the desired state created during assign operation on the entities. It is used to ensure the authorized owner can make modification of desired state.

This property was added in vSphere API 9.0.0.0.

If missing or null, no orchestrator detail is provided during the assign operation.

Note:

  1. It is used by vLCM orchestrators like SDDC Manager to manage the desired state. For a non-orchestrator user i.e. a VC user, it must be unset.

  2. Setting it prevents other users from modifying the committed desired state.